<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>uartns550: xuartns550_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">uartns550
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xuartns550__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xuartns550_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the UART 16450/16550 driver (<a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a>) and hardware device using interrupt mode. </p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00b jhl  02/13/02 First release
1.00b sv   06/08/05 Minor changes to comply to Doxygen and coding guidelines
1.01a sv   05/08/06 Minor changes for supporting Test App Interrupt examples
2.00a ktn  10/20/09 Updated to use HAL processor APIs and minor modifications
              as per coding guidelines.
2.01a ssb  01/11/01 Updated the example to be used with the SCUGIC in
              Zynq.
3.2   adk  15/10/14 Clear the global counters.If multiple instance of ip is
              present in the h/w design without clearing these counters
              will result undefined behaviour for the second ip
                      instance while running the peripheral tests.
3.4   ms   01/23/17 Added xil_printf statement in main function to
                    ensure that "Successfully ran" and "Failed" strings
                    are available in all examples. This is a fix for
                    CR-965028.
3.6   rna  01/06/20 Clean up options at end to get Success/Failure strings
3.9   gm   07/09/23 Added SDT support.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6fd3d40371e5c88dc9ad53c75a7f2950"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartns550__intr__example_8c.html#a6fd3d40371e5c88dc9ad53c75a7f2950">UartNs550IntrExample</a> (INTC *IntcInstancePtr, <a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *UartInstancePtr, u16 UartDeviceId, u16 UartIntrId)</td></tr>
<tr class="memdesc:a6fd3d40371e5c88dc9ad53c75a7f2950"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does a minimal test on the UartNs550 device and driver as a design example.  <a href="#a6fd3d40371e5c88dc9ad53c75a7f2950">More...</a><br/></td></tr>
<tr class="separator:a6fd3d40371e5c88dc9ad53c75a7f2950"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6afc272c9c7feecb2b9b25f00c430227"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartns550__intr__example_8c.html#a6afc272c9c7feecb2b9b25f00c430227">UartNs550IntrHandler</a> (void *CallBackRef, u32 Event, unsigned int EventData)</td></tr>
<tr class="memdesc:a6afc272c9c7feecb2b9b25f00c430227"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the handler which performs processing to handle data events from the UartNs550.  <a href="#a6afc272c9c7feecb2b9b25f00c430227">More...</a><br/></td></tr>
<tr class="separator:a6afc272c9c7feecb2b9b25f00c430227"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xuartns550__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the UartNs550 interrupt example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the UartNs550 interrupt example. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xuartns550__intr__example_8c.html#a6fd3d40371e5c88dc9ad53c75a7f2950">UartNs550IntrExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a6fd3d40371e5c88dc9ad53c75a7f2950"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int UartNs550IntrExample </td>
          <td>(</td>
          <td class="paramtype">INTC *&#160;</td>
          <td class="paramname"><em>IntcInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_uart_ns550.html">XUartNs550</a> *&#160;</td>
          <td class="paramname"><em>UartInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>UartDeviceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>UartIntrId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function does a minimal test on the UartNs550 device and driver as a design example. </p>
<p>The purpose of this function is to illustrate how to use the <a class="el" href="struct_x_uart_ns550.html" title="The XUartNs550 driver instance data. ">XUartNs550</a> component.</p>
<p>This function transmits data and expects to receive the same data through the UART using the local loopback of the hardware.</p>
<p>This function uses interrupt driver mode of the UART.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IntcInstancePtr</td><td>is a pointer to the instance of the Interrupt Controller. </td></tr>
    <tr><td class="paramname">UartInstancePtr</td><td>is a pointer to the instance of the UART . </td></tr>
    <tr><td class="paramname">UartDeviceId</td><td>is the device Id and is typically XPAR_&lt;UARTNS550_instance&gt;_DEVICE_ID value from xparameters.h. </td></tr>
    <tr><td class="paramname">UartIntrId</td><td>is the interrupt Id and is typically XPAR_&lt;INTC_instance&gt;_&lt;UARTNS550_instance&gt;_IP2INTC_IRPT_INTR value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>This function contains an infinite loop such that if interrupts are not working it may never return. </p>

<p>References <a class="el" href="xuartns550__intr__example_8c.html#a6afc272c9c7feecb2b9b25f00c430227">UartNs550IntrHandler()</a>, <a class="el" href="group__uartns550.html#ga120797e7b4fc719c827c4378e387efe4">XUartNs550_GetOptions()</a>, <a class="el" href="group__uartns550.html#ga97009bf7b2508c14225b0d5835c256d0">XUartNs550_Initialize()</a>, <a class="el" href="group__uartns550.html#ga6e8579fcf317e1f30d61b4fb7fe60434">XUartNs550_InterruptHandler()</a>, <a class="el" href="group__uartns550.html#ga2c5e715e9e90bd93e68c47e1cd398be5">XUartNs550_LookupConfig()</a>, <a class="el" href="group__uartns550.html#ga35fc171801e394fce29cbcb09dc1ff99">XUartNs550_Recv()</a>, <a class="el" href="group__uartns550.html#ga2ec86252a3b83b8d7b4815ffb960562d">XUartNs550_SelfTest()</a>, <a class="el" href="group__uartns550.html#ga421921af6a8df7c51ddbfa5d2301ad1b">XUartNs550_Send()</a>, <a class="el" href="group__uartns550.html#gadf7c4826f92d5e8fd70763f4448a360d">XUartNs550_SetHandler()</a>, <a class="el" href="group__uartns550.html#gac2270082fbb7d7b2c32bd9208dae5be3">XUartNs550_SetOptions()</a>, <a class="el" href="group__uartns550.html#ga616329329f125e69b957d98d23c0c80d">XUN_OPTION_DATA_INTR</a>, <a class="el" href="group__uartns550.html#ga9bd45da1706d1d6cfc0f22d4fca46100">XUN_OPTION_FIFOS_ENABLE</a>, and <a class="el" href="group__uartns550.html#gaaf47eddf3f91b4dfea5fa70849ccf094">XUN_OPTION_LOOPBACK</a>.</p>

<p>Referenced by <a class="el" href="xuartns550__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a6afc272c9c7feecb2b9b25f00c430227"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UartNs550IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Event</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>EventData</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the handler which performs processing to handle data events from the UartNs550. </p>
<p>It is called from an interrupt context such that the amount of processing performed should be minimized.</p>
<p>This handler provides an example of how to handle data for the UART and is application specific.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>contains a callback reference from the driver, in thiscase it is the instance pointer for the UART driver. </td></tr>
    <tr><td class="paramname">Event</td><td>contains the specific kind of event that has occurred. </td></tr>
    <tr><td class="paramname">EventData</td><td>contains the number of bytes sent or received for sent and receive events.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__uartns550.html#gab5c78c74113daef4f74aefbc57e92b3a">XUartNs550_GetLastErrors()</a>, <a class="el" href="group__uartns550.html#gabc9845fc2ec5078c1beea2b1e1f8458c">XUN_EVENT_RECV_DATA</a>, <a class="el" href="group__uartns550.html#ga658d137ce80d2dba58593fdc9266eded">XUN_EVENT_RECV_ERROR</a>, <a class="el" href="group__uartns550.html#gadcf08384f79c532d7476ef470eeef32a">XUN_EVENT_RECV_TIMEOUT</a>, and <a class="el" href="group__uartns550.html#ga935c9a27e790c469337b884f42db9266">XUN_EVENT_SENT_DATA</a>.</p>

<p>Referenced by <a class="el" href="xuartns550__intr__example_8c.html#a6fd3d40371e5c88dc9ad53c75a7f2950">UartNs550IntrExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
